scandirectory
Advanced tools
Scan a directory recursively with a lot of control and power
npm install --save scandirectoryrequire('scandirectory')This package is published with the following editions:
scandirectory aliases scandirectory/source/index.jsscandirectory/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
var scandir = require('scandirectory')
var path = process.cwd()
var options = {}
function completionCallback (err, list, tree) {
console.log({
error: err,
list: list,
tree: tree
})
/*
{
error: null,
list: {
'a file.txt': 'file',
'a directory': 'dir',
'a directory/a sub file.txt': 'file'
},
tree: {
'a file.txt': true,
'a directory': {
'a sub file.txt': 'true
}
}
}
*/
}
scandir(path, options, completionCallback)
Scan directory options:
action - (default null) can be null or a function to use for both the fileAction and dirActionfileAction - (default null) can be null, false, or a function to be the action callbackdirAction - (default null) can be null, false, or a function to the action callbackrecurse - (default true) can be null or a boolean for whether or not to scan subdirectories tooreadFiles - (default false) can be null or a boolean for whether or not we should read the file contentsThe options object is also sent to ignorefs so you can use its options too
The completion callback accepts the following arguments:
err - null or an error that has occuredlist - a collection of all the child nodes in a list/object format:
{fileRelativePath: 'dir|file'}tree - a collection of all the child nodes in a tree format:
{dir: {dir:{}, file1:true} }The results for a specific argument is only generated if the argument is requested.
The action callbacks accept the following arguments:
fullPath - the full/absolute path of the current file/directoryrelativePath - the relative path of the current file/directory with respect to the original scanning pathfilename - the basename of the current file/directorystat - a simple stat object provided by readdir-clusterThe action callbacks can return false to skip the path from being processed further.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Discover the release history by heading on over to the HISTORY.md file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under:
FAQs
Scan a directory recursively with a lot of control and power
We found that scandirectory demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.